home *** CD-ROM | disk | FTP | other *** search
/ Chip 1996 November / Chip 11-96.iso / treiber / grafik / datapat / q2000 / install / qinit.doc < prev    next >
Text File  |  1991-11-28  |  13KB  |  324 lines
  1.                                  RELEASE NOTES
  2.                                       for
  3.                                   Version 2.09
  4.                                      of the
  5.                       Configurable Initialization Program
  6.                                and its companion
  7.                      Interactive Configuration File Editor.
  8.  
  9.  
  10. In the notes below where Q-PC is used it refers to either a Q-PC, Q-MCA or a
  11. Q2000 board.
  12.  
  13.                                      QINIT
  14.  
  15. NAME
  16.     QINIT - configurable Q-PC board initializer.
  17.  
  18. SYNOPSIS
  19.     QINIT [-a] [-b] [-f font_xy] [-h] [-i screen_initial_xy] [-o po_ctrl]
  20.     [-p] [-q qpc_no] [-s] [-v] [config file]
  21.  
  22. DESCRIPTION
  23.     All the above parameters to QINIT are optional.
  24.  
  25.     QINIT's primary and default operation is to initialize the first Q-PC
  26.     board in your computer with the set of parameters contained in the
  27.     configuration file, and inform the Q-PC hardware characteristics
  28.     driver of the board's hardware characteristics.
  29.  
  30.     If the Q-PC hardware characteristics driver is not resident when a Q-PC
  31.     board number greater than one is specified or when a Q-PC hardware
  32.     characteristic differing from the following defaults:-
  33.  
  34.         Q-PC board base address (0300H)
  35.         Q-PC board interrupt request number (IRQ) (10)
  36.         Q-PC board DMA channel (7)
  37.         Q-PC board memory size X (2048)
  38.         Q-PC board memory size Y (1024)
  39.         Q-PC board memory fold (1024)
  40.         Q-PC board planes (0x0f)
  41.  
  42.     is specified, the board initialization will be aborted.
  43.     
  44.     The initialization sequence is :-
  45.  
  46.         1. Reset the QPDM.
  47.         2. Initialize the QPDM monitor parameters.
  48.         3. Set up the Q-PC hardware characteristics driver.
  49.         4. Set the default QPDM drawing modes.
  50.         5. Clear all of the video memory.
  51.         6. Initialize the palette.
  52.         7. Load a 9 by 14, a 11 by 20 & a 12 by 24 font into the
  53.            off screen memory.
  54.         8. Display the Datapath company logo and a
  55.            `initialization completed statement'.
  56.         
  57.     If a file extension is not specified for the `config file' QCF is
  58.     assumed. If your `config file' has not got a file extension you must
  59.     enter a '.' after the file name. The file extension BAK is not allowed.
  60.     If `config file' is omitted, the default file QPC.QCF is used. You may
  61.     copy the configuration file for your `favourite' monitor to this file
  62.     to save typing. When no disk drive or path has been specified as part
  63.     of the `config file' specification, the following actions are taken:-
  64.  
  65.         1) the configuration file is looked for in the current
  66.         directory.
  67.  
  68.         2) if the file wasn't found then
  69.  
  70.         a) if the environment variable QCFDIR is set, the path found
  71.         there is used to specify the directory where the configuration
  72.         file should be found.
  73.  
  74.         b) otherwise the directories specified in the PATH environment
  75.         variable are searched for the configuration file.
  76.  
  77.     The other options allow you to do the following :-
  78.  
  79.         -a allows the Q-PC hardware characteristics driver to be
  80.         `avoided' for the storage of memory information ie if this
  81.         option is used the Q-PC hardware characteristics driver need
  82.         not be present in memory even if the board being initialized
  83.         has a memory configuration to the default.
  84.         THIS OPTION IS INTENDED FOR DEBUGGING PURPOSES ONLY AND SHOULD
  85.         NOT GENERALLY BE USED.
  86.  
  87.         -b turns on backwards compatibility with versions of
  88.         QINIT/QCONFIG prior to 2.00.  It may be required if
  89.         drivers/utilities issued prior to 1st June 1990, by Datapath,
  90.         or non-Datapath drivers are used.  See `technical information'
  91.         later on if you want to see what it affects.  It is ignored in
  92.         the Q2000 versions of QINIT/QCONFIG.
  93.  
  94.         -f font_xy, where font_xy is either:-
  95.  
  96.           1) a QPDM absolute X, Y address pair (entered as 1280,0 or
  97.           "1280 0" for example), specifies the top left hand corner of
  98.           the area where the fonts should be stored.  They are stored,
  99.           by default, just off the screen at the top right for memory
  100.           configurations except F, G & H where they are stored just off
  101.           the screen at the bottom left.
  102.  
  103.           2) the letter 'r', specifies that the top left hand corner
  104.           of the area where the fonts should be stored, should be just
  105.           off the screen at the top right.
  106.  
  107.           3) the letter 'b', specifies that the top left hand corner
  108.           of the area where the fonts should be stored, should be just
  109.           off the screen at the bottom left.
  110.  
  111.           4) the letter 'x', specifies that the fonts should be stored,
  112.           at the top right as far over in x as possible.
  113.  
  114.           5) the letter 'y', specifies that the fonts should be stored,
  115.           at the bottom left as far down in y as possible.
  116.  
  117.           6) the letter 'v', specifies that the fonts should be stored,
  118.           in the correct place for the Vutrax driver.
  119.  
  120.         -h performs a hard reset of the Q-PC board. A hard reset is
  121.         items 1 and 2 of the initialization sequence described above.
  122.         Note that -s has precedence over -h therefore if they are both
  123.         specified only the -s will be executed.
  124.         
  125.         -i screen_initial_xy, where screen_initial_xy is a QPDM
  126.         absolute X, Y address pair (entered as 1280,0 or "1280 0" for
  127.         example), specifies the top left hand corner of the screen.
  128.         The default coordinates for the top left hand corner of the
  129.         screen when this option isn't specified, are 0,0.  This option
  130.         is provided so that off screen memory may be examined on a UNIX
  131.         system.  It is designed to be used with the -h option so that
  132.         the memory isn't altered.
  133.  
  134.         -o po_ctrl, where po_ctrl means palette overlay control and can
  135.         be `on', `off' or a number, controls the overlaying of the
  136.         bottom half of the video memory or which planes of the video
  137.         memory are to be displayed by the palette.  Note that this
  138.         option is only effective if the palette is initialized.
  139.  
  140.         -p allows you to specify that only the palette should be
  141.         initialized. Hence the board parameters, monitor parameters
  142.         and initialization completed statement need not be present in
  143.         the `config file'. Note that if -p is specified with -s, the
  144.         palette will be initialized with QINIT's default palette data,
  145.         not the palette data in a 'config file'.
  146.  
  147.         -q qpc_no, where qpc_no is a base 10 number, is used to specify
  148.         which Q-PC board in the computer that the parameters in the
  149.         `config file' refer to, and hence for which board the hardware
  150.         characteristics from the configuration file should be stored in
  151.         the Q-PC hardware characteristics driver.
  152.  
  153.         -s performs a soft reset of the Q-PC board. A soft reset is
  154.         items 4, 5 and 7 of the initialization sequence described above.
  155.         Note that if -s is specified a `config file' is never read, even
  156.         if one is given.
  157.         
  158.         -v causes the version number message to be issued. The board
  159.         is not initialized if this option is given.
  160.  
  161.     The -f & -o options should only really be used when instructed to do so
  162.     in the installation instructions of a Q-PC driver.
  163.  
  164.     The -h, -s & -p options do not inform the Q-PC hardware characteristics
  165.     driver of the boards hardware characteristics but rely on the
  166.     characteristics previously set into the driver.
  167.  
  168.     QINIT returns the following exit codes:-
  169.         0 - File parsed and Q-PC graphics board initialized O.K.
  170.         1 - Q-PC graphics board initialization completed incorrectly.
  171.         2 - A invalid file specification was given on the shell command
  172.             line.
  173.         3 - The file specified could not be found.
  174.         4 - There were invalid options on the shell command line.
  175.         5 - There was an erroneous parameter in one of the obligatory
  176.             sections found in the file.
  177.         6 - The Q-PC hardware characteristics driver was not resident
  178.             when a Q-PC board number greater than one was specified or
  179.             when a Q-PC hardware characteristic differing from the
  180.             following defaults:-
  181.             Q-PC board base address (0300H)
  182.             Q-PC board interrupt request number (IRQ) (10)
  183.             Q-PC board DMA channel (7)
  184.             Q-PC board memory size X (2048)
  185.             Q-PC board memory size Y (1024)
  186.             Q-PC board memory fold (1024)
  187.         7 - The Q-PC board number specified was reported as invalid by
  188.             the Q-PC hardware characteristics driver.
  189.         8 - The Q-PC board was found to be incorrectly initialized when
  190.             trying to perform a soft reset operation or palette
  191.             initialization.
  192.         9 - The version message option was given therefore QINIT gave
  193.             the requested version message then exited.
  194.  
  195. EXAMPLES
  196.     QINIT cotron64
  197.     -- initializes according to parameters in COTRON64.QCF
  198.  
  199.     QINIT
  200.     -- initializes according to parameters in QPC.QCF
  201.  
  202.  
  203.                             THE CONFIGURATION FILES
  204.  
  205. The configuration files end in .QCF (for Q-PC ConFiguration). You can edit
  206. these files with the Interactive Configuration File Editor or with a text
  207. editor IF YOU KNOW WHAT YOU'RE DOING, using the text editor being the harder
  208. of the two.
  209.  
  210. Note: The monitor vertical parameters in the configuration file relate to the
  211. field and so when using interlacing they are half the values for the frame.
  212.  
  213. Configuration files, for the supported Q-PC board and monitor combinations, are
  214. built using the utility QCFBUILD.
  215.  
  216.  
  217.                                     QCONFIG
  218.  
  219. NAME
  220.     QCONFIG - the interactive configuration file editor program.
  221.  
  222. SYNOPSIS
  223.     QCONFIG [-a] [-b] [-q qpc_no] [config file]
  224.  
  225. DESCRIPTION
  226.     All the above parameters to QCONFIG are optional and have the following
  227.     functions :-
  228.  
  229.         -a allows the Q-PC hardware characteristics driver to be
  230.         `avoided' for the storage of memory information ie if this
  231.         option is used the Q-PC hardware characteristics driver need
  232.         not be present in memory even if the board being initialized
  233.         has a memory configuration to the default.
  234.         THIS OPTION IS INTENDED FOR DEBUGGING PURPOSES ONLY AND SHOULD
  235.         NOT GENERALLY BE USED.
  236.  
  237.         -b turns on backwards compatibility with versions of
  238.         QINIT/QCONFIG prior to 2.00.  It may be required if
  239.         drivers/utilities issued prior to 1st June 1990, by Datapath,
  240.         or non-Datapath drivers are used.  See `technical information'
  241.         later on if you want to see what it affects.  It is ignored in
  242.         the Q2000 versions of QINIT/QCONFIG.
  243.  
  244.         -q qpc_no, where qpc_no is a base 10 number, is used to specify
  245.         which Q-PC board, in the computer, the parameters in the `config
  246.         file' refer to and hence for which board, the hardware
  247.         characteristics from the configuration file should be stored in
  248.         the Q-PC hardware characteristics driver.
  249.  
  250.         `config file' is a configuration file specification and is used
  251.         to specify the configuration file you initially wish to edit
  252.         with QCONFIG. If a file extension is not specified for the
  253.         `config file' QCF is assumed. If your `config file' has not got
  254.         a file extension you must enter a '.' after the file name. The
  255.         file extension BAK is not allowed.
  256.  
  257.     QCONFIG is entirely menu driven and its operation should be self
  258.     explanatory to its intended users - persons familiar with the
  259.     operation of monitors and the Q-PC boards.
  260.  
  261.     Note: The Initialization Completed Correctly Statement is only saved
  262.     in the configuration file if it is altered from the default of
  263.     'Initialization Completed', similarly only the palette colours that are
  264.     altered from their default values, which can be seen by looking at the
  265.     Palette Colours menu when you haven't read in a configuration file, are
  266.     saved.
  267.  
  268.     Once you have created a configuration file with QCONFIG you may insert
  269.     a comment, about the configuration described by the parameters in the
  270.     file, at the start of the file with a text editor.
  271.  
  272.     QCONFIG returns the following exit codes:-
  273.         0 - File parsed and Q-PC graphics board initialized O.K.
  274.         1 - There were invalid options on the shell command line.
  275.  
  276.  
  277.             TECHNICAL INFORMATION
  278.  
  279. The QPDM's SXT register is set to half what it should be to avoid funnies with
  280. large values, unless the -b option is used with non Q2000 versions of
  281. QINIT/QCONFIG.  A 0 in the SYT register means 4096.
  282.  
  283. The default QPDM drawing modes set are :-
  284.  
  285.     viewport 0,0 = screen bottom left
  286.     scale factor = unity ie no scaling
  287.     activity bits = 0x0f
  288.     listen bits = 0x0f
  289.     clipping, picking and Logical PEL are disabled
  290.  
  291. For old style Q-PC configuration files with TYPE parameters:-
  292.  
  293.     The palette overlay is turned on for board types 1 & 2 when the on
  294.     screen Y resolution isn't greater than the memory fold.
  295.  
  296. For Q-PC configuration files with PLANES parameters:-
  297.  
  298.     The top 4 bits of the plane mask are used to turn on the palette overlay
  299.     planes when the on screen Y resolution isn't greater than the memory
  300.     fold.
  301.  
  302. The default memory configuration is that of a 1M QPC2
  303. ie a short 1M Q-PC/Datapath 1024 board which is as follows:-
  304.  
  305.     2048, 1024,        /* memory size */
  306.     512,                /* memory fold */
  307.     0,                    /* board type */
  308.     0,                    /* board flags */
  309.     0x0f,                /* planes fitted - mainly for monochrome card */
  310.  
  311.  
  312. Ian Partridge
  313.  
  314. V2.09 29 NOV 91
  315.  
  316. DATAPATH Ltd
  317. Alfreton Road
  318. Derby
  319. DE2 4AD
  320. ENGLAND
  321.  
  322. Tel. (0332) 294441
  323. Fax. (0332) 290667
  324.